<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Whisper: CDatagramBuilder Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Whisper
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#pri-static-attribs">Static Private Attributes</a>  </div>
  <div class="headertitle">
<div class="title">CDatagramBuilder Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="CDatagramBuilder" --><!-- doxytag: inherits="IPacketSource" -->
<p>datagram builder for communication  
 <a href="classCDatagramBuilder.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="datagram__builder_8h_source.html">datagram_builder.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CDatagramBuilder:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCDatagramBuilder.png" usemap="#CDatagramBuilder_map" alt=""/>
  <map id="CDatagramBuilder_map" name="CDatagramBuilder_map">
<area href="classIPacketSource.html" title="packet source implementing a packet-based protocol" alt="IPacketSource" shape="rect" coords="0,0,115,24"/>
</map>
 </div></div>

<p><a href="classCDatagramBuilder-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a457b11236a5417cf1075a39f0ccdea87">CDatagramBuilder</a> (<a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *pConfig, <a class="el" href="classIStegIO.html">IStegIO</a> *pStegIO)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a01b356a8d8016fe6104f5944d1f3d0c9">~CDatagramBuilder</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceNPacketSource.html#a41d32c941906c55fd056bc4be5e0c79b">NPacketSource::EPayloadInfo</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a181dc65bc7cda68d55ac289dfff4e241">getPacket</a> (void *&amp;pPacket, unsigned int &amp;pPacketLength, unsigned int pMaxLength)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a1819520ff57281331f9b202e2aa5772d">putPacket</a> (void *pPacket, unsigned int pPacketLength)</td></tr>
<tr><td colspan="2"><h2><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#ae78649b2c5dcface92bd430a449e52d8">CDatagramBuilder</a> (const <a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a906078596889489191b45dbb5ecc2b8e">operator=</a> (const <a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a> &amp;)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a6250fff7d087ddca0dc227a6d29c0942">getByteBuffer</a> (unsigned int pSize)</td></tr>
<tr><td colspan="2"><h2><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a7b5cc7ebb8ac6054b10630b6c6eb70d4">mConfig</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIStegIO.html">IStegIO</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#ae88b531e1dd2f2ef96fc72935ce26ab4">mStegIO</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a19a299261022615ab596c5d98f8ecb0c">mByteBuffer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a4f8ae20947a3fefa350680ee414efcd3">mByteBufferSize</a></td></tr>
<tr><td colspan="2"><h2><a name="pri-static-attribs"></a>
Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static const std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCDatagramBuilder.html#a7e4e5879ffd902e977e59213fa116bb3">sIniSectionName</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>datagram builder for communication </p>
<dl class="author"><dt><b>Author:</b></dt><dd>mnutzinger, jwurzer </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a457b11236a5417cf1075a39f0ccdea87"></a><!-- doxytag: member="CDatagramBuilder::CDatagramBuilder" ref="a457b11236a5417cf1075a39f0ccdea87" args="(CPropertiesReader *pConfig, IStegIO *pStegIO)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CDatagramBuilder::CDatagramBuilder </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a> *&#160;</td>
          <td class="paramname"><em>pConfig</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classIStegIO.html">IStegIO</a> *&#160;</td>
          <td class="paramname"><em>pStegIO</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a01b356a8d8016fe6104f5944d1f3d0c9"></a><!-- doxytag: member="CDatagramBuilder::~CDatagramBuilder" ref="a01b356a8d8016fe6104f5944d1f3d0c9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CDatagramBuilder::~CDatagramBuilder </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ae78649b2c5dcface92bd430a449e52d8"></a><!-- doxytag: member="CDatagramBuilder::CDatagramBuilder" ref="ae78649b2c5dcface92bd430a449e52d8" args="(const CDatagramBuilder &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CDatagramBuilder::CDatagramBuilder </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6250fff7d087ddca0dc227a6d29c0942"></a><!-- doxytag: member="CDatagramBuilder::getByteBuffer" ref="a6250fff7d087ddca0dc227a6d29c0942" args="(unsigned int pSize)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char * CDatagramBuilder::getByteBuffer </td>
          <td>(</td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pSize</em></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a181dc65bc7cda68d55ac289dfff4e241"></a><!-- doxytag: member="CDatagramBuilder::getPacket" ref="a181dc65bc7cda68d55ac289dfff4e241" args="(void *&amp;pPacket, unsigned int &amp;pPacketLength, unsigned int pMaxLength)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceNPacketSource.html#a41d32c941906c55fd056bc4be5e0c79b">NPacketSource::EPayloadInfo</a> CDatagramBuilder::getPacket </td>
          <td>(</td>
          <td class="paramtype">void *&amp;&#160;</td>
          <td class="paramname"><em>pPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int &amp;&#160;</td>
          <td class="paramname"><em>pPacketLength</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pMaxLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>get a packet from the packet source (from upper to lower layer) </p>
<dl class="note"><dt><b>Note:</b></dt><dd>pPacket and pPacketLength only make sense if return value is true </dd>
<dd>
minimum payload length is always 1 (if return value of true)</dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pPacket</td><td>pointer to the bytes representing the packet </td></tr>
    <tr><td class="paramname">pPacketLength</td><td>number of bytes </td></tr>
    <tr><td class="paramname">pMaxLength</td><td>maximum number of bytes for the returned packet </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on data available, false otherwise </dd></dl>

<p>Implements <a class="el" href="classIPacketSource.html#a646c3a5cc1c03628145471697b1abf54">IPacketSource</a>.</p>

</div>
</div>
<a class="anchor" id="a906078596889489191b45dbb5ecc2b8e"></a><!-- doxytag: member="CDatagramBuilder::operator=" ref="a906078596889489191b45dbb5ecc2b8e" args="(const CDatagramBuilder &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a>&amp; CDatagramBuilder::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classCDatagramBuilder.html">CDatagramBuilder</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a1819520ff57281331f9b202e2aa5772d"></a><!-- doxytag: member="CDatagramBuilder::putPacket" ref="a1819520ff57281331f9b202e2aa5772d" args="(void *pPacket, unsigned int pPacketLength)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CDatagramBuilder::putPacket </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pPacket</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>pPacketLength</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>put a packet to the packet source (from lower to upper layer)</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">pPacket</td><td>pointer to the bytes representing the packet </td></tr>
    <tr><td class="paramname">pPacketLength</td><td>number of bytes </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classIPacketSource.html#ad2c03d2e3370eef80a207617bd561f26">IPacketSource</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a19a299261022615ab596c5d98f8ecb0c"></a><!-- doxytag: member="CDatagramBuilder::mByteBuffer" ref="a19a299261022615ab596c5d98f8ecb0c" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned char* <a class="el" href="classCDatagramBuilder.html#a19a299261022615ab596c5d98f8ecb0c">CDatagramBuilder::mByteBuffer</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a4f8ae20947a3fefa350680ee414efcd3"></a><!-- doxytag: member="CDatagramBuilder::mByteBufferSize" ref="a4f8ae20947a3fefa350680ee414efcd3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classCDatagramBuilder.html#a4f8ae20947a3fefa350680ee414efcd3">CDatagramBuilder::mByteBufferSize</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a7b5cc7ebb8ac6054b10630b6c6eb70d4"></a><!-- doxytag: member="CDatagramBuilder::mConfig" ref="a7b5cc7ebb8ac6054b10630b6c6eb70d4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="properties__reader_8h.html#a67847fd00cb49d80dd45f61722eb9a43">CPropertiesReader</a>* <a class="el" href="classCDatagramBuilder.html#a7b5cc7ebb8ac6054b10630b6c6eb70d4">CDatagramBuilder::mConfig</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ae88b531e1dd2f2ef96fc72935ce26ab4"></a><!-- doxytag: member="CDatagramBuilder::mStegIO" ref="ae88b531e1dd2f2ef96fc72935ce26ab4" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classIStegIO.html">IStegIO</a>* <a class="el" href="classCDatagramBuilder.html#ae88b531e1dd2f2ef96fc72935ce26ab4">CDatagramBuilder::mStegIO</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="a7e4e5879ffd902e977e59213fa116bb3"></a><!-- doxytag: member="CDatagramBuilder::sIniSectionName" ref="a7e4e5879ffd902e977e59213fa116bb3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string <a class="el" href="classCDatagramBuilder.html#a7e4e5879ffd902e977e59213fa116bb3">CDatagramBuilder::sIniSectionName</a><code> [static, private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="datagram__builder_8h_source.html">datagram_builder.h</a></li>
<li><a class="el" href="datagram__builder_8cxx.html">datagram_builder.cxx</a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>



<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 25 2012 22:00:42 for Whisper by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
